home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / util / time / MBClock.lha / MBClock / MBClock_ENG.doc < prev    next >
Text File  |  1998-12-11  |  6KB  |  208 lines
  1. Introduction
  2. ------------
  3. MBClock is a very simple clock that runs as a Commodity on the default
  4. pubscreen.
  5.  
  6. MBClock was written in Oberon-A ©1995 by Frank Copeland.
  7.  
  8. Note:
  9. The code for the clock was taken almost directly from Horst Schuman's
  10. public domain clock.e code. (But improved a bit. It uses only about half of
  11. the CPU time and it uses less memory even though my Clock program
  12. has more features :-) )
  13.  
  14. (Sorry about the missing Danish doc. I hate writing docs and therefore
  15.  I will not translate any of my docs to Danish. It takes too much time.)
  16.  
  17.  
  18. Copyright
  19. ---------
  20. MBClock 1.3 is Copyright 1997 Morten Bjergstrøm.
  21.  
  22. This piece of software is freely distributable but still copyrighted.
  23. Therefore you are not allowed to change the program in anyway and you
  24. are not allowed to remove or add anything to the archive.
  25.  
  26. You are allowed to spread this program as much as you like but you may
  27. not make any profit of it.
  28.  
  29. I cannot in anyway be held responsible for any damage MBClock may do to
  30. your hardware or software or anything else. You use MBClock entirely on
  31. your OWN risk.
  32.  
  33.  
  34. It is allowed to include this program on public domain/shareware disks
  35. if the price of one disk doesn't exceed 15 Dkr (4DM, $2).
  36.  
  37. It is allowed to include this program on CD-ROMS if the price of the
  38. CD-ROM doesn't exceed the price of an Aminet CD (129Dkr, 20-25DM)
  39.  
  40. Magazines have to get my written permission to include MBClock on their
  41. coverdisks/cdroms. If a magazine gets my written permission to use MBClock
  42. on one of their coverdisks/cdroms they have to send me a copy of that
  43. magazine including the coverdisk/cdrom free of charge.
  44.  
  45.  
  46. Requirements
  47. ------------
  48. MBClock requires OS2.1 and a bit of memory to run.
  49.  
  50.  
  51. Installation
  52. ------------
  53. Just copy the MBClock drawer where ever you want.
  54. And if you need it you should copy the catalog for your language to
  55. LOCALE:Catalogs/<language>/
  56.  
  57.  
  58. Usage
  59. -----
  60. MBClock can be started from either the Shell or the Workbench.
  61. MBClock is installed as a Commodity therefore you can quit MBClock
  62. with the Exchange program. (The Active/Inactive cycle gadget has no effect)
  63.  
  64. MBClock supports the following tooltype:
  65.  
  66. DATEFORMAT (English version)
  67. In addition MBClock supports a localized version of the tooltype.
  68.  
  69. The dateformat is a string containing control characters and normal text.
  70. The following control characters are supported (taken from the locale
  71. autodoc):
  72.  
  73.  
  74.                  %a - abbreviated weekday name
  75.                  %A - weekday name
  76.                  %b - abbreviated month name
  77.                  %B - month name
  78.                  %c - same as "%a %b %d %H:%M:%S %Y"
  79.                  %C - same as "%a %b %e %T %Z %Y"
  80.                  %d - day number with leading 0s
  81.                  %D - same as "%m/%d/%y"
  82.                  %e - day number with leading spaces
  83.                  %h - abbreviated month name
  84.                  %H - hour using 24-hour style
  85.                  %I - hour using 12-hour style
  86.                  %j - julian date
  87.                  %m - month number with leading 0s
  88.                  %M - the number of minutes with leading 0s
  89.                  %n - insert a linefeed
  90.                  %p - AM or PM strings
  91.                  %r - same as "%I:%M:%S %p"
  92.                  %R - same as "%H:%M"
  93.                  %S - number of seconds with leadings 0s
  94.                  %t - insert a tab character
  95.                  %T - same as "%H:%M:%S"
  96.                  %U - week number, taking Sunday as first day of week
  97.                  %w - weekday number
  98.                  %W - week number, taking Monday as first day of week
  99.                  %x - same as "%m/%d/%y"
  100.                  %X - same as "%H:%M:%S"
  101.                  %y - year using two digits with leading 0s
  102.                  %Y - year using four digits with leading 0s
  103.  
  104. Example:
  105.  
  106.   DATEFORMAT=%A. %d %B %Y
  107.  
  108. will produce something like: Tuesday. 23 September 1997
  109.  
  110.  
  111. When started from the shell MBClock supports one argument:
  112. English version: DATEFORMAT
  113.  
  114. (Note you have to write DATEFORMAT on the commandline else the argument
  115. won't be recognized!)
  116.  
  117. EXAMPLE:
  118.   Run >NIL: <NIL: MBClock DATEFORMAT "%A. %d %B %Y"
  119.  
  120. will produce something like: Tuesday. 23 September 1997
  121.  
  122. Note:
  123.   The week number options for the dateformat don't work as they should.
  124.   Probably due to a bug in locale.library.
  125.  
  126.  
  127. By pressing 'j' or 'J' in the active MBClock window you can jump the MBClock
  128. window to the next public screen. (See below for bugs and remember that the
  129. jump key is localized!)
  130.  
  131.  
  132. Bugs
  133. ----
  134. When 'j' is pressed to jump the MBClock window to the next public screen
  135. problems can encounter if there are any public screens in the system that
  136. doesn't allow visitor windows. This is not dangerous. Only annoying.
  137.  
  138. Note:
  139. The only program I know that doesn't allow visitor windows on it's public
  140. screen is CygnusEd ©1987-1993 CygnusSoft Software.
  141.  
  142.  
  143. Translators
  144. -----------
  145. If you translate MBClock then remember to include a small text file like the
  146. example below (please send translations (.cd and .ct files) to me and I will
  147. include them in the next release of MBClock):
  148.  
  149.  
  150. MBClock Danish translation by:
  151.   Morten Bjergstrøm
  152.   Holmebækhuse 115
  153.   4681 Herfølge
  154.   Denmark
  155.  
  156.   EMail: morten_gomez@hotmail.com
  157.  
  158.  
  159. DATEFORMAT = DATOFORMAT
  160. JUMPKEY (J)= J
  161.  
  162.  
  163. History
  164. -------
  165. 20/ 9/1997: 1.0 First version
  166. 22/ 9/1997: 1.1 Second version
  167.             Added date in the screen title bar.
  168.             Corrected a bug that could close timer.device even though it was
  169.             not opened.
  170. 10/10/1997: 1.2
  171.             Now checks if disk based libraries was opened.
  172.             Tooltype and shell argument support for the date format.
  173.             Added possibility to jump to the next public screen by pressing
  174.             'j' or 'J' in the active MBClock window. (See Bugs)
  175.             Corrected one more bug in the timer routines.
  176.  5/12/1997: 1.3 (First public version)
  177.             Clock has been renamed to MBClock and is now partly localized.
  178.             The window is now always activated when it is jumped to another
  179.             screen.
  180.  
  181.  
  182. To do
  183. -----
  184. - Error messages when something goes wrong. (If anybody needs them.)
  185. - Other improvements. Tell me what you need.
  186. - Full localization (localization of ReadArgs. The Shell template).
  187.  
  188.  
  189. Address
  190. -------
  191. Mail address:
  192.  
  193.   Morten Bjergstrøm
  194.   Krovænget 11
  195.   4671 Strøby
  196.   Denmark
  197.  
  198.  
  199. EMail address:
  200.   mbjergstroem@hotmail.com
  201.  
  202.  
  203. Other programs by me
  204. --------------------
  205. AddIcon (should be in util/wb)
  206. OberonAModules (should be in dev/obero)
  207. SortIcons (should be in util/wb)
  208.